.. Oppy documentation master file, created by
   sphinx-quickstart on Thu Jul  8 14:20:34 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

********
oppy API
********

.. automodule:: oppy
   :members:
   :undoc-members:
   :show-inheritance:


Available subpackages
---------------------
:ref:`conOpt<conOpt package>` 
    Subpackage which provides some methods for constraint optimization.
:ref:`itMet<itMet package>`
    Iterative methods for solving linear systems.
:ref:`leastSquares<leastSquares package>`
    Least Squares optimization methods.
:ref:`linOpt<linOpt package>`
    Linear optimization methods.
:ref:`multiOpt<multOpt package>`
    Multiobjective optimization methods.
:ref:`options<options package>`
    Module contains the options class for all methods use in oppy.
:ref:`results<results package>`
    This module contains the class for the returns which oppy use.
:ref:`tests<tests package>`
    Unittests of oppy.
:ref:`unconOpt<unconOpt package>`
    Subpackage which provides some methods for unconstrained optimization. 
:ref:`visualization<visualization package>`
    Some methods for visualization.


Subpackages
===========

.. toctree::
   :maxdepth: 3

   Constrained Optimization/oppy.conOpt.rst
   Iterative Optimization/oppy.itMet.rst
   Least Squares/oppy.leastSquares.rst
   Linear Optimization/oppy.linOpt.rst
   Multiobjective Optimization/oppy.multOpt.rst
   Options/oppy.options.rst
   Results/oppy.results.rst
   Unconstrained Optimization/oppy.unconOpt.rst
   Visualization/oppy.visualization.rst
   Testing/oppy.test.rst